Skip to content

Add missing upgrade doc - #31226

Merged
jonathanfrappier merged 6 commits into
mainfrom
docs/fix-broken-ha-upg-link
Jul 8, 2025
Merged

Add missing upgrade doc#31226
jonathanfrappier merged 6 commits into
mainfrom
docs/fix-broken-ha-upg-link

Conversation

@jonathanfrappier

Copy link
Copy Markdown
Contributor

Description

What does this PR do?

  • Reported broken docs link from Discuss
  • Add vault-ha-upgrade.mdx to upgrade directory (redirects support the theory this should have been there)

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've documented the impact of any changes to security controls.

Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

@github-actions

github-actions Bot commented Jul 8, 2025

Copy link
Copy Markdown

CI Results:
All Go tests succeeded! ✅

@github-actions

github-actions Bot commented Jul 8, 2025

Copy link
Copy Markdown

Build Results:
All builds succeeded! ✅

brianshumate
brianshumate previously approved these changes Jul 8, 2025
yhyakuna
yhyakuna previously approved these changes Jul 8, 2025
@jonathanfrappier
jonathanfrappier dismissed stale reviews from yhyakuna and brianshumate via 86755af July 8, 2025 18:06
@jonathanfrappier
jonathanfrappier requested a review from Copilot July 8, 2025 18:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a missing upgrade document for HA deployments and fixes a broken link in the replication guide

  • Added a new “vault-ha-upgrade” page under the upgrade directory
  • Updated the site navigation to include the HA upgrade page
  • Fixed the link in replicated-deployment.mdx to point to the new upgrade path

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
website/data/docs-nav-data.json Added nav entry for “Manual upgrade for HA deployments”
website/content/docs/upgrade/vault-ha-upgrade.mdx New HA upgrade guide for pre-1.11 and opt-out scenarios
website/content/docs/upgrade/replicated-deployment.mdx Updated link to the HA upgrade guide under /upgrade
Comments suppressed due to low confidence (2)

website/data/docs-nav-data.json:982

  • [nitpick] The nav title (‘Manual upgrade for HA deployments’) doesn’t match the page title (‘Vault HA upgrades without Autopilot Upgrade Automation’). Consider aligning the nav entry title with the document’s H1/frontmatter title for consistency.
        "title": "Manual upgrade for HA deployments",

website/content/docs/upgrade/vault-ha-upgrade.mdx:13

  • The link anchor #automated-upgrade differs from the later link using #automated-upgrades. Verify the correct anchor in the target page to avoid a broken link.
- Opt-out the [Autopilot automated upgrade](/vault/docs/concepts/integrated-storage/autopilot#automated-upgrade) features with Vault 1.11 or later

Comment thread website/content/docs/upgrade/vault-ha-upgrade.mdx Outdated
Comment thread website/content/docs/upgrade/replicated-deployment.mdx Outdated
jonathanfrappier and others added 3 commits July 8, 2025 14:26
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
yhyakuna
yhyakuna previously approved these changes Jul 8, 2025
@jonathanfrappier
jonathanfrappier merged commit 4753119 into main Jul 8, 2025
33 checks passed
@jonathanfrappier
jonathanfrappier deleted the docs/fix-broken-ha-upg-link branch July 8, 2025 20:34
Erfankam pushed a commit to Erfankam/vault that referenced this pull request Sep 1, 2025
* Add missing upgrade doc

* Add doc nav

* Update website/content/docs/upgrade/vault-ha-upgrade.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update website/content/docs/upgrade/replicated-deployment.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Remove duplicate redirect

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants